library: lr1110: Add library for LR1110 support #458

ethanzhouyc · 2024-07-22T03:49:26Z

Add lr1110 library and two related example applications. This library uses Seeed Studio's code as user space, built upon Tock, to provide support for the LR1110 LoRa chip on Wio-WM1110 development board. Applications could use the library to collect sensor data, join TTN, perform Wi-Fi scans, and send data to TTN for geolocation.

alistair23

Cool! Soon Tock will have so much LoRa support!

alistair23 · 2024-07-23T04:43:44Z

examples/tests/lorawan/main_lorawan.c

+#define LORAWAN_DEVICE_EUI  "70B3D57ED00650D9"
+#define LORAWAN_JOIN_EUI    "901AB1F40E1BCC81"
+#define LORAWAN_APP_KEY     "3356A7047ECF1F2F78C72AE9B1635BC1"


Are these your keys? You want to keep the keys secret, you probably want to have this default to 0 and users can set them

alistair23 · 2024-07-23T04:53:56Z

lr1110/lr1110/src_changed/smtc_hal_mcu.c

+void hal_clock_init(void)
+{
+    //nrf_drv_clock_init();
+    //nrf_drv_clock_lfclk_request( NULL );
+}


These empty functions should just be removed instead of commented out

alistair23 · 2024-07-23T04:54:31Z

lr1110/lr1110/src_changed/region_us_915.c

+/**
+ * \file      region_us_915.c
+ *
+ * \brief     region_us_915 abstraction layer implementation


Why does this file need to be modified?

alistair23 · 2024-07-23T04:59:29Z

examples/tests/lorawan/README.md

@@ -0,0 +1,21 @@
+# LoRa Basics Modem LoRaWAN Class A/C example


I think it should be clear that this only targets the Wio WM1110

bradjc · 2024-07-23T15:18:44Z

I'm working on putting the finishing touches on this pr

ethanzhouyc · 2024-07-24T00:12:23Z

@bradjc Maybe we should keep wifi_helpers.c in the src_changed folder for now. Changes in these lines make sure that the app does not return error when the board sometimes scans too many Wi-Fi access points.

ethanzhouyc · 2024-07-24T00:13:57Z

Great to see the library been further cleaned up!

bradjc · 2024-07-24T02:37:56Z

@bradjc Maybe we should keep wifi_helpers.c in the src_changed folder for now. Changes in these lines make sure that the app does not return error when the board sometimes scans too many Wi-Fi access points.

Good point. I think I was thinking we should change WIFI_MAX_RESULTS, but that isn't straightforward easy, and could run into the same issue.

bradjc · 2024-07-24T02:40:34Z

I wasn't able to actually get this to work, and I think I've traced the issue back to changes to how the alarm_read function works. I forgot to compile the library when I tested so I still need to verify this, but this is my working diff:

diff --git a/lr1110/lr1110/src_changed/smtc_hal_rtc.c b/lr1110/lr1110/src_changed/smtc_hal_rtc.c
index 39cc844e..15cb80ac 100644
--- a/lr1110/lr1110/src_changed/smtc_hal_rtc.c
+++ b/lr1110/lr1110/src_changed/smtc_hal_rtc.c
@@ -10,7 +10,7 @@
 // static uint32_t rtc_2_tick_diff = 0;

 // static void rtc_2_handler( nrf_drv_rtc_int_type_t int_type )
-// {
+// {
 //     if( int_type == NRF_DRV_RTC_INT_OVERFLOW )
 //     {
 //         rtc_2_tick_diff += RTC_2_MAX_TICKS;
@@ -43,17 +43,47 @@ uint32_t hal_rtc_get_time_ms( void )
     return timeInms / 10;
 }

+static uint32_t ticks_to_100us(uint32_t ticks) {
+  // `ticks_to_ms`'s conversion will be accurate to within the range
+  // 0 to 1 milliseconds less than the exact conversion
+  // (true millisecond conversion - [0,1) milliseconds).
+
+  uint32_t frequency;
+  libtock_alarm_command_get_frequency(&frequency);
+
+  uint32_t seconds = (ticks / frequency);
+  uint32_t hundredus_per_second = 10000;
+
+  // Calculate the conversion of full seconds to ticks.
+  uint32_t hundredus = seconds * hundredus_per_second;
+
+  // To get conversion accuracy within 1 millisecond, the conversion
+  // must also convert partial seconds.
+  uint32_t leftover_ticks = ticks % frequency;
+
+  // This calculation is mathematically equivalent to doing:
+  //
+  //   `leftover_ticks` / (`frequency` / `hundredus_per_second`)
+  //
+  // This is taking the remaining unconverted ticks (leftover_ticks)
+  // and dividing by the number of ticks per millisecond
+  // (`frequency` (ticks per second) / `1000` hundredus per second)
+  // The division is done this way because of the same argument in
+  // `ms_to_ticks`.
+  hundredus += (leftover_ticks * hundredus_per_second) / frequency;
+
+  return hundredus;
+}
+
 uint32_t hal_rtc_get_time_100us( void )
 {
     // double temp = nrf_drv_rtc_counter_get( &rtc_2 ) + rtc_2_tick_diff;
     // return temp * RTC_2_PER_TICK * 10;
-
+
     uint32_t time = 0;
     uint32_t frequency = 0;
     libtock_alarm_command_read(&time);
-    libtock_alarm_command_get_frequency(&frequency);
-    uint32_t timeIn100us = (time * 10000) / frequency;
-    return timeIn100us;
+    return ticks_to_100us(time);
 }

 // uint32_t hal_rtc_get_max_ticks( void )
@@ -64,7 +94,7 @@ uint32_t hal_rtc_get_time_100us( void )
 void hal_rtc_wakeup_timer_set_ms( const int32_t milliseconds )
 {
     libtocksync_alarm_delay_ms(milliseconds);
-
+
     // uint32_t temp = 0;
     // float temp_f = milliseconds;
     // temp_f = temp_f / RTC_2_PER_TICK + 1;
@@ -82,5 +112,5 @@ void hal_rtc_wakeup_timer_set_ms( const int32_t milliseconds )

 // void hal_rtc_wakeup_timer_stop( void )
 // {
-
+
 // }

alistair23 · 2024-07-24T02:41:09Z

@bradjc Maybe we should keep wifi_helpers.c in the src_changed folder for now. Changes in these lines make sure that the app does not return error when the board sometimes scans too many Wi-Fi access points.

Good point. I think I was thinking we should change WIFI_MAX_RESULTS, but that isn't straightforward easy, and could run into the same issue.

Can you upstream the fix?

If frequency is high, then `leftover_ticks * 1000` can exceed a 32 bit number.

In case the timer has a high frequency.

bradjc · 2024-07-26T14:56:42Z

Ok I can confirm that better handling the ticks to 100us conversion fixed the issue.

bradjc · 2024-08-05T18:30:24Z

I need to work on the build error of course but otherwise I think I have this PR to a state where it is reasonably mergeable.

alistair23 · 2024-08-06T01:58:58Z

examples/tests/lr1110/lorawan/main_lorawan.c

+/*!
+ * @brief Defines the application data transmission duty cycle. 60s (changed to 3s), value in [s].
+ */
+#define APP_TX_DUTYCYCLE 3


Is this how often data is uploaded?

If it is this is really low! This breaks TTN usage policy and I think breaks FCC laws in America

I remembered it is how often the app makes an attempt to transmit data to TTN, and if the transmission succeeds, the duty cycle will stop. I agree that we should make it a larger number, but if it's too large, like 60, it might fail the app.

It's way too low then, this needs to be at least 60 minutes

Since this is only for a test app, the impact should be minimal here.

It's not minimal impact, people will be banned from TTN if they run the test app and get caught.

Not to mention it's possible a crime in some countries

examples/tests/lr1110/lorawan/main_lorawan.c

examples/tests/lr1110/wifi_scan/README.md

examples/tests/lr1110/wifi_scan/main_geolocation_wifi.c

alistair23 · 2024-08-06T02:08:11Z

lr1110/Makefile.app

+SEEED_DIR = $(LR1110_DIR)/seeed
+
+# include changed headers and parameters
+override CFLAGS += -I$(LR1110_DIR)/inc_changed -DREGION_US_915 -DRP2_103 -DTASK_EXTENDED_2 -DLR11XX -DLR11XX_TRANSCEIVER


Same here. I think the region setting needs a better solution

Ideally we should prompt users to input their region code, but we discussed to agree that this approach will be sufficient for the current stage.

Who discussed?

This isn't sufficient as you don't actually allow people to change it. It's set here and in the code and completely undocumented

We will think about that a bit more

alistair23 · 2024-08-06T02:09:21Z

lr1110/lr1110/us_915_ttn.c

+#include "lr1_stack_mac_layer.h"
+#include "lr1mac_utilities.h"
+#include "lorawan_api.h"


Again, what about other regions?

It will be hard to test in other regions too

You don't have to test it, but the library supports a range of regions which they have tested. You just need to allow users to set the region

lr1110/lr1110/src_changed/smtc_hal_mcu.c

alistair23 · 2024-08-06T02:11:11Z

lr1110/wifi_helpers.patch

+-        MW_DBG_TRACE_ERROR( "Wi-Fi scan result size exceeds %u (%u)\n", max_nb_results, nb_results );
+-        return false;
+        // Just use the number we received that can fit in our results array.
+        nb_results = max_nb_results;


Why change this?

The app returns an error if more than 5 results are detected, which sometimes occurs when there are many Wi-Fi access points nearby. This update retains all original functionality while preventing potential errors.

That should go upstrem then

Seeed Studio is not going to upstream this. It is caused by integrating their code with Tock OS.

Then that's a bug that should be fixed, not just hacked around

alistair23 · 2024-08-06T02:11:43Z

lr1110/radio_planner.patch

+        // For some reason we get a spurious RX_TIMEOUT interrupt sometimes.
+        // Handling it causes the stack to break, but clearing it causes the
+        // stack to work.
+        // re-get the irq status if RX_TIMEOUT happens (current workaround)
+        if( rp_task_type == RP_TASK_TYPE_WIFI_RSSI) {
+            if(rp->status[rp->radio_task_id] == RP_STATUS_RX_TIMEOUT) {
+                rp_irq_get_status( rp, rp->radio_task_id );
+                // return;
+            }
+        }


This should be upstreamed, not just hacked around

It's the only workaround we could find. We spent lots of time debugging this and it's hard to resolve

Is there an issue opened against the original library?

No, their code will work fine on their OS stack, but we are integrating their code into Tock OS here.

alistair23 · 2024-08-26T03:11:38Z

examples/tests/lr1110/lorawan/main_lorawan.c

-#define LORAWAN_DEVICE_EUI "70B3D57ED00650D9"
-#define LORAWAN_JOIN_EUI   "901AB1F40E1BCC81"
-#define LORAWAN_APP_KEY    "3356A7047ECF1F2F78C72AE9B1635BC1"


Just an FYI, the key is still here. So make sure you revoke it from TTN

ethanzhouyc and others added 18 commits July 21, 2024 23:24

build wm1110 library

96b3049

add changed inc first

30d3cb2

fix folder path

5f59570

final fix

7587fc3

add .gitignore

2ea9788

rename lib

0ffbc6d

list full file paths

f7ad37e

add README.md

2a6681d

fix comments

c34c174

rebase and adapt new naming

8c597fd

fix more naming

6f01584

clean up changed headers

f41069e

clean up changed sources

5612b59

clean unnecessary changes

4ad88a7

clean seeed folder

cfcb911

more clean up

047d905

move examples to test folder

a15df31

lr1110: simplify modified headers

15a2653

alistair23 suggested changes Jul 23, 2024

View reviewed changes

bradjc added 10 commits July 23, 2024 12:01

format makefiles

1a82cd0

move ttn bank 2 config to its own file

54dc088

use built in lr1110/src_changed/apps_modem_event.c

4f132ab

use update function to set internal lib val

a7a2607

hal gpio: cleanup

b5176b9

hal lp time: cleanup

35bd9a7

mcu hal cleanup

5be573e

rng hal cleanup

21e0afe

spi hal cleanup

65a0607

trace hal cleanup

84eff7d

rtc hal cleanup

36ed17e

bradjc added 2 commits July 26, 2024 10:48

libtock: alarm: ticks_to_ms can rollover

fc30e27

If frequency is high, then `leftover_ticks * 1000` can exceed a 32 bit number.

lr1110: hal rtc: update to more robust logic

3b9c966

In case the timer has a high frequency.

bradjc added 2 commits August 1, 2024 13:28

tests: move to lr1110 folder

139bef8

lr1110: more cleanup to the hal files

85ac466

bradjc mentioned this pull request Aug 1, 2024

lora: Initial commit of LoRaWAN example #456

Merged

bradjc added 9 commits August 1, 2024 15:17

lr1110: hal: cleanup and comment

6c284cb

add wifi_helpers patch

ec8a149

add smtc_modem patch

611e708

add radio_planner patch

bc5730f

lr1110: make: need to include us 915 source file

f2d1b15

lorawan example compile without warnings

03607a6

tests: lr1110: wifi app cleanup

3dbf713

lr1110 remove header that has warnings

8f801bd

lr1110 tests: format apps

4e566e2

alistair23 suggested changes Aug 6, 2024

View reviewed changes

ethanzhouyc added 2 commits August 25, 2024 15:30

remove README

2a6f568

remove secret key

b2fd588

alistair23 reviewed Aug 26, 2024

View reviewed changes

		@@ -0,0 +1,21 @@
		# LoRa Basics Modem LoRaWAN Class A/C example

library: lr1110: Add library for LR1110 support #458

Are you sure you want to change the base?

library: lr1110: Add library for LR1110 support #458

Conversation

ethanzhouyc commented Jul 22, 2024

alistair23 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bradjc commented Jul 23, 2024

ethanzhouyc commented Jul 24, 2024

ethanzhouyc commented Jul 24, 2024

bradjc commented Jul 24, 2024

bradjc commented Jul 24, 2024

alistair23 commented Jul 24, 2024

bradjc commented Jul 26, 2024

bradjc commented Aug 5, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment